/*
 * Copyright (C) 2011 by Fabien Barbero
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flickr.api.blogs;

import com.flickr.api.FlickrServiceException;
import com.flickr.api.photos.Photo;
import java.util.List;

/**
 *
 * @author Fabien Barbero
 */
public interface BlogService {
    
    /**
     * Get the supported blog types.
     * @return                          The list of blog types.
     * @throws FlickrServiceException   Error getting types.
     */
    List<BlogType> getSupportedBlogsTypes()
            throws FlickrServiceException;
    
    /**
     * Get the blogs.
     * @param type                      The type of reached blogs. If null all blogs are returned.
     * @return                          The list of blogs.
     * @throws FlickrServiceException   Error getting blogs.
     */
    List<Blog> getBlogs(BlogType type)
            throws FlickrServiceException;
    
    /**
     * Get the blogs.
     * @return                          The list of blogs.
     * @throws FlickrServiceException   Error getting blogs.
     */
    List<Blog> getBlogs()
            throws FlickrServiceException;
    
    /**
     * Post a photo to a blog.
     * @param blog                      The blog.
     * @param photo                     The photo to post.
     * @param title                     The title of the photo.
     * @param description               The description of the photo.
     * @param password                  The password of the blog (not mandatory).
     * @throws FlickrServiceException   Error posting the photo.
     */
    void postPhoto(Blog blog, Photo photo, String title, String description, char[] password)
            throws FlickrServiceException;
    
}
